home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1998 July / EnigmA AMIGA RUN 29 (1998)(G.R. Edizioni)(IT)[!][issue 1998-07 & 08].iso / recent / crunch.lha / crunchdir / crunchdir_E.txt < prev   
Text File  |  1998-06-15  |  8KB  |  208 lines
  1.  
  2.                           CrunchDir v1.26 (05.04.98)
  3.                          ----------------------------
  4.  
  5.                                  Users manual
  6.                                 --------------
  7.  
  8.   ===========================================================================
  9.   0.    Contents
  10.   ---------------------------------------------------------------------------
  11.  
  12.         1. Preface and Disclaimer
  13.         2. What's CrunchDir
  14.         3. System requirements
  15.         4. Installation
  16.         5. Arguments
  17.         6. Author
  18.         7. Greets
  19.  
  20.  
  21.   ===========================================================================
  22.   1.    Preface and Disclaimer
  23.   ---------------------------------------------------------------------------
  24.  
  25.   This  program and all files in this archive are © 1997/98 by Thomas Knuppe.
  26.   They  can  be  freely copied as long as the archive and all it's containing
  27.   files are unmodified.
  28.  
  29.   I am not responsible for any damage which  accur during or after the use of
  30.   this program.
  31.  
  32.   The  program was written with Amiga_E on an Amiga A4000/030 with OS 3.1 and
  33.   was testet on an A4000 (OS3.1) and A3000T (OS2.04).
  34.  
  35.   Nevertheless: Please contact me if an error accurs.
  36.  
  37.  
  38.   ===========================================================================
  39.   2.    What's CrunchDir
  40.   ---------------------------------------------------------------------------
  41.  
  42.   I  wrote  CrunchDir,  because  my BBS-System doesn't allow to manage binary
  43.   filebases on their contents or date.
  44.  
  45.   CrunchDir scans the given directory recursively and deletes all files which
  46.   are older than given days from the actual date.
  47.  
  48.  
  49.   ===========================================================================
  50.   3.    System requirements
  51.   ---------------------------------------------------------------------------
  52.  
  53.   This  program  needs  only  an  AMIGA with OS2.04 and a 68k CPU (any better
  54.   system should also be fine :-) )
  55.  
  56.   CrunchDir runs on two BBS-Systems every day and doesn't hurt anyone ;-)
  57.  
  58.  
  59.   ===========================================================================
  60.   4.    Installation
  61.   ---------------------------------------------------------------------------
  62.  
  63.   The  installation  is as easy as possible.  Just copy the program into your
  64.   C:   directory  or  whereever  you  want.   Now,  wipe  the sweat from your
  65.   forehead :-)
  66.  
  67.  
  68.   ===========================================================================
  69.   5.    Arguments
  70.   ---------------------------------------------------------------------------
  71.  
  72.   Template    :   DIR/A,PATTERN,DAYS=D/K/N,LOGFILE=LOG/K,NOTIME/S,ADDLOG/S:
  73.  
  74.   DIR/A       :   The  directory  to  be  cleaned.   The  program  scans this
  75.                   directory recursively !
  76.  
  77.                   This  argument  has  to be given !  If an empty string ("")
  78.                   was given the program scans in the current directory !
  79.  
  80.   PATTERN     :   An  AmigaDOS-Pattern  to take influence on the filenames to
  81.                   check.   E.g. "(b#?)" check only  files which  begin with a
  82.                   "b".
  83.  
  84.                   Caution : The pattern is case-sensitive !
  85.  
  86.                   If  this  argument  is not given the program uses "(#?)" as
  87.                   pattern which means that all files will be checked.
  88.  
  89.                   AmigaDOS-like  you  can  also give a negative pattern (e.g.
  90.                   "~(#?.txt)" ).
  91.  
  92.   DAYS=D      :   With  this  argument you give the amount of days which will
  93.                   be subtracted from the actual date to define the age of the
  94.                   files to be deleted.
  95.  
  96.                   It sounds complicated but it's easy. Example :
  97.  
  98.                   Only files which are older than 20 days shall be deleted:
  99.  
  100.                   D=20
  101.  
  102.                   This  argument is a so called KEYWORD.  It has to be given,
  103.                   too. Examples :
  104.  
  105.                   DAYS=10 , D 5 , D=70
  106.  
  107.                   If  this  argument  is  not  used  or if the amount of days
  108.                   overrun  the  actual  date  the program uses a preset of 30
  109.                   days !
  110.  
  111.   LOGFILE=LOG :   This  argument  can  be used to generate a logfile were all
  112.                   actions  of  the  program  will be  mentioned.  You have to
  113.                   give a filename !
  114.  
  115.                   Example:  LOG="RAM:CD-LOG.TXT"
  116.  
  117.                   While  the  program  runs it will also generate a temporary
  118.                   file  in  the  logical  directory  "T:".  This file will be
  119.                   deleted after the use of CrunchDir.
  120.  
  121.                   The program adds a comment to the logfile that contains the
  122.                   amount of deleted files and errors.
  123.  
  124.   NOTIME/S    :   With  this arg you can  switch the time off. No !  The time
  125.                   is still running ;-) It means that the datetime of the file
  126.                   and the actual  day is not  used  for the check.  With this
  127.                   switch CrunchDir only deletes Files which are really x days
  128.                   old.
  129.  
  130.   ADDLOG/S    :   This argument is to add the logfile to an existing logfile.
  131.                   This  will  be  done  by the last-in-first-out - principle.
  132.                   The  logs on top of the file are the newest.  Each log-item
  133.                   has it's own header.
  134.  
  135.                   The  Filenote (see also the LOGFILE-argument) contains only
  136.                   informations about the _last_ run of CrunchDir !
  137.  
  138.  
  139.   Example program-call :
  140.  
  141.   Crunchdir Files:Stuff ~(BOARDINFO#?) D=2 LOGFILE T:Crunchdir.log
  142.  
  143.   This  call would delete all Files in the cirectory "Files:Stuff" (and lower
  144.   directorys)  which  are  older than 2 days except of files which begin with
  145.   the term "BOARDINFO".  Also a logfile with the name "Crunchdir.log" will be
  146.   generated on the logical device T:  .
  147.  
  148.   The  time of the files to be checked and the time of the actual day will be
  149.   used  for the check.  You can ignore  the Time by  the switch NOTINE/S (see
  150.   above)
  151.  
  152.   ATTENTION !   The  program  only deletes files which are deleteable !  This
  153.                 means  that  the protection-bits of the files are not changed
  154.                 by  the  program.  If a file is protected against deletion it
  155.                 will  not be deleted (therefore the protection-bits were made
  156.                 :-) ). An  error-message  will  only  occur if  a  logfile is
  157.                 generated.
  158.  
  159.  
  160.   ===========================================================================
  161.   6.    Author
  162.   ---------------------------------------------------------------------------
  163.  
  164.   This program and the manuals were written by
  165.  
  166.   Thomas 'Shadow' Knuppe, Berlin, Germany
  167.  
  168.   I am reachable under the following addresses :
  169.  
  170.   E-Mail        :       EsHaDe@gmx.de
  171.  
  172.   Home          :       http://home.pages.de/~shd
  173.  
  174.   IRC           :       'sHD' or 'EsHaDe' on IRCNet
  175.  
  176.   FAX           :       +49 (0)30 667 09 543
  177.  
  178.   BBS           :       Outside world - +49 (0)30 667 09 150    X.75
  179.                                                   667 09 151    v34+
  180.                                                   667 09 543    v32b/ZyX +FAX
  181.                         [AMMS 3]                  667 09 544    v32b
  182.  
  183.  
  184.   ===========================================================================
  185.   7.    Regards
  186.   ---------------------------------------------------------------------------
  187.  
  188.   I wish to thank the following people...
  189.  
  190.   Till 'MacGyver' Klöpping        -     Without  your routines  this  program
  191.                                         would not exist :-)
  192.  
  193.   Ronny 'Cannon' Schulz [IDP!]    -     for the best tools you wrote for AMMS                                        for AMMS.
  194.  
  195.   Roman 'Galax-e' Harneit         -     for  all   the   things   we  managed
  196.                                         together in 1997 =)
  197.  
  198.   Rolf 'Digi-Bit' Müller          -     for the suggestions you made
  199.  
  200.   Enya                            -     for the coding-music ;)
  201.  
  202.   Wouter van Oortmerssen          -     for one of the best programming-
  203.                                         languages built for the Amiga.
  204.                                         (Amiga_E)
  205.  
  206.  
  207.   ===========================================================================
  208.